Create Custom Placeholders for Processing Jobs and Cases (Projects)

Applies To: eCapture Controller

In the eCapture Controller, custom placeholders can be created for each rule in a Processing Job. They can also be created at the Case (Project) level.

A custom placeholder will be used in the event an item is marked as an error for a Processing Job. The labels for the placeholder are retained with the exception of the metadata fields which will display as blank.

Create a Custom Placeholder for a Processing Job

The following instructions only cover how to create a custom placeholder using the Flex Rules Processor Manager when creating a new Processing Job. For more detailed instructions on creating a Processing Job, see Create a Standard Processing Job.

To create a Custom Placeholder for a Processing Job using the Flex Processor Manager:

1. Create a New Processing job. Right-click on the Processing Jobs folder and select New Processing Job.

2. On the Filtering tab, click on the button. The Create Custom Placeholder Configuration dialog displays.

   

3. Click on the button.

4. From the Action drop down, select Placeholder or Placeholder with Document Text.

   

5. Click the Select metadata fields link. The Create Custom Placeholder Configuration dialog displays.

   

6. Click the drop-down menu located above the Available Fields list and select a specific field type.

   

   By default, all fields display.

7. To narrow the field list

   1. Enter a value in the Filter Value field located below the Available Fields list. For example, to see only those fields that contain the word “date”, enter date.
   2. Click .

      

8. To display all fields, delete the value, in this case the word date, and click .
9. Click to move a selected field from the Available Fields box to the Selected Fields box.
10. Click to move a selected field from the Selected Fields box to the Available Fields box.
11. Click to open the Insert Custom Field dialog where you can create new group fields and new user fields.
12. Use the and arrows to change the order of the fields in the Selected Fields box. Select a field (or contiguous fields) and then use either arrow to reposition the selected field(s) .

13. Select a field in the Selected Fields box. The selected field appears in the Font section. Click to open the Font dialog.

    

14. Select from the Font options and click OK to return to the Custom Placeholder Configuration dialog. Repeat for each additional field.

15. In the Field Options section, if necessary, check Include labels with values. When selected both the field label and its value are included.

    

16. Click . The Date Field Formatting Options dialog displays.

17. Set the date format and time format for the custom placeholder.

    

    1. If you want to change the date field to a different format, click on the drop-down arrow and select from the following date formats:

       

       • YYYYMMDD

       • YYYY/MM/DD

       • MMDDYYYY

       • MM/DD/YYYY

       • DD/MM/YYYY

       • Otherwise, select the option, Do Not Convert Date Fields.

    2. If you want to change the Time Format, click on the drop-down menu and select from the following options:

       

       • 12-hour [displays time in 12 hour format, e.g. 1:04]

       • 24-hour [displays time in 24 hour format, e.g. 13:04]

       • Regional [formats the time according to the “default” Regional Settings of the Worker the document is being exported on. Note: Changing the format strings using the “Customize” button of Regional Settings will have no effect; the actual region needs to be changed to see any effect.

    3. Select Resolve times to second precision if you want to add seconds to all metadata date fields that have time. This does not apply to the images.

    4. By default, the Legacy Date Field Formatting check box is checked. Uncheck this option to select from the Invalid date options and to select fields for date format handling.

18. If you unchecked the Legacy Date Field Formatting check box, set the Invalid Date options:

    

    1. Treat date values outside of specified range as invalid dates - Select a start date and end date range. Any dates outside of the selected range will be considered as invalid dates. The start date default is set to SQL minimum date. The end date default is set to SQL maximum date.

    2. Select one of the following options:

       • Invalid date field output value - enter text to display in the event an invalid date is encountered. This field may be left blank.

       • Invalid date field output do not convert - invalid dates will be output as a text field.

19. From the list of Available Fields, select the fields you want to use for date formatting and move them to the Fields Selected for Date Format Handling box. There are a few considerations about date fields to keep in mind:

    • The only fields that are not present in the list are *DATE_ONLY* and *TIME_ONLY*. The fields in the available field list are comprised of fields that are marked as valid for date formatting. This is determined by the value of TRUE in the ExportAttemptDateParse field located in the EncounteredMetatdataFieldList table.

    • Date field formatting options affect only those fields in the Fields Selected for Date Format Handling box.

    • Date field formatting options are set at the Job level.

    To select fields for date format handling.

    1. Select a field for date format handling by selecting the field from the Fields Available for Date Format Handling and clicking to move the single field to the Fields Selected for Date Format Handling box.

    2. For two or more fields, ctrl-click to select non-contiguous fields or shift-click to select contiguous fields. Once the fields are selected, click to move them to the Fields Selected for Date Format Handling box.

       eCapture creates two additional fields that “split” the date and time into a Date Only field and a Time Only field. These two additional fields will be displayed in the Available Fields list in the Export Wizard, Select Export Fields screen. For example, if the DueDate field was moved to the Fields Selected for Date Format Handling, the following additional DueDate fields would appear in the Available Fields list: DueDate*DATE ONLY* and DueDate*TIME ONLY*.

20. When you are finished setting the Date Field Formatting options, click OK. The Custom Placeholder dialog displays.

21. In the Placement Options box, select the placement settings for the placeholder.

    

    1. Set the alignment positioning for the placeholder.

       • Vertical Alignment: Determines placement along the vertical axis. Options include Top, Center, or Bottom. Top is the default.

       • Horizontal Alignment: Determines placement along the horizontal axis. Options include Left, Center, or Right. Left is the default.

    2. Set the left and right indentation for the placeholder. This setting determines the horizontal spacing to the left or right of the page margins.
    3. Set the truncation for the placeholder. Truncation determines the number of characters at which the field value will be truncated. The default value is 128 characters.

22. If you want to save your Custom Placeholder formatting to a file, to be used later, click the Save button, enter a Description for the placeholder, and click OK. You will also be prompted to save the custom placeholder definition before you exit the Custom Placeholder Definition dialog.

23. When you are finished creating the custom placeholder, click OK. The Save Changes dialog box displays.
    1. Click Yes to save the custom placeholder definition.
    2. Enter a Description for the placeholder.
    3. Click OK.
24. The Success dialog appears indicating the ID number for the saved Placeholder. The Custom Placeholder Configuration dialog closes.
25. The Flex Processor Rules Manager dialog displays. Click to save your changes
26. Click Exit.

Note: When viewing the Data Panel for a selected Processing Job or Data Extract Job in the Client Management treeview, you can click to view the rule settings for the job. However, if the job started, you cannot modify the rule options.

Create a Custom Placeholder for a Case (Project)

The following instructions only cover how to create a custom placeholder, using the Flex Rules Processor Manager, when creating a new Case (Project). These settings are for standard Processing Jobs for the Case. For more detailed instructions on creating a new Case (Project), see Create a New Case (Project).

Note: When creating a case, you can also define specific placeholder criteria for Streaming Discovery Jobs. For more information, see Create Custom Placeholders for a Streaming Imaging Job.

To create a Custom Placeholder for a Case (Project) Flex Processing Rule ( for standard Processing Jobs):

1. Create a New Case (Project).

   1. Right-click on a Client and then select New Case (Project).

   2. On the New Case (Project) initial dialog, enter the Enterprise Details for the new case (project). The Options for Case (Project) dialog displays.

      

2. Click on the Filtering tab.

3. Click on the button. The Create Custom Placeholder Configuration dialog displays.

   

4. Click on the button.

5. From the Action drop down, select Placeholder.

   

6. Click the Select metadata fields link. The Create Custom Placeholder Configuration dialog displays.

   

7. Click the drop-down menu located above the Available Fields list and select a specific field type.

   

   By default, all fields display.

8. To narrow the field list

   1. Enter a value in the Filter Value field located below the Available Fields list. For example, to see only those fields that contain the word “date”, enter date.
   2. Click .

      

9. To display all fields again, delete the value, in this case the word date, and click .
10. Click to move a selected field from the Available Fields box to the Selected Fields box.
11. Click to move a selected field from the Selected Fields box to the Available Fields box.
12. Click to open the Insert Custom Field dialog where you can create new group fields and new user fields.
13. Use the and arrows to change the order of the fields in the Selected Fields box. Select a field (or contiguous fields) and then use either arrow to reposition the selected field(s) .

14. Select a field in the Selected Fields box. The selected field appears in the Font section. Click to open the Font dialog.

    

15. Select from the Font options and click OK to return to the Custom Placeholder Configuration dialog. Repeat for each additional field.

16. In the Field Options section, if necessary, check Include labels with values. When selected, both the field label and its value are included.

    

17. Click . The Date Field Formatting Options dialog displays.

18. Set the date format and time format for the custom placeholder.

    

    1. If you want to change the date field to a different format, click on the drop down arrow and select from the following date formats:

       

       • YYYYMMDD

       • YYYY/MM/DD

       • MMDDYYYY

       • MM/DD/YYYY

       • DD/MM/YYYY

       • Otherwise, select the option, Do Not Convert Date Fields.

    2. If you want to change the Time Format, click on the drop-down menu and select from the following options:

       

       • 12-hour [displays time in 12 hour format e.g. 1:04]

       • 24-hour [displays time in 24 hour format, e.g. 13:04]

       • Regional [formats the time according to the “default” Regional Settings of the Worker the document is being exported on. Note: Changing the format strings using the “Customize” button of Regional Settings will have no effect; the actual region needs to be changed to see any effect.

    3. Select Resolve times to second precision if you want to add seconds to all metadata date fields that have time. This does not apply to the images.

    4. By default, the Legacy Date Field Formatting check box is checked. Uncheck this option to select from the Invalid date options and to select fields for date format handling.

19. If you unchecked the Legacy Date Field Formatting check box, set the Invalid Date options:

    

    1. Treat date values outside of specified range as invalid dates - Select a start date and end date range. Any dates outside of the selected range will be considered as invalid dates. The start date default is set to SQL minimum date. The end date default is set to SQL maximum date.

    2. Select one of the following options:

       • Invalid date field output value - enter text to display in the event an invalid date is encountered. This field may be left blank.

       • Invalid date field output do not convert - invalid dates will be output as a text field.

20. From the list of Available Fields, select the fields you want to use for date formatting and move them to the Fields Selected for Date Format Handling box. There are a few considerations about date fields to keep in mind:

    • The only fields that are not present in the list are *DATE_ONLY* and *TIME_ONLY*. The fields in the available field list are comprised of fields that are marked as valid for date formatting. This is determined by the value of TRUE in the ExportAttemptDateParse field located in the EncounteredMetatdataFieldList table.

    • Date field formatting options affect only those fields in the Fields Selected for Date Format Handling box.

    • Date field formatting options are set at the Job level.

    To select fields for date format handling:

    1. Select a field for date format handling by selecting the field from the Fields Available for Date Format Handling and clicking to move the single field to the Fields Selected for Date Format Handling box.

    2. For two or more fields, ctrl-click to select non-contiguous fields or shift-click to select contiguous fields. Once the fields are selected, click to move them to the Fields Selected for Date Format Handling box.

       eCapture creates two additional fields that “split” the date and time into a Date Only field and a Time Only field. These two additional fields will be displayed in the Available Fields list in the Export Wizard, Select Export Fields screen. For example, if the DueDate field was moved to the Fields Selected for Date Format Handling, the following additional DueDate fields would appear in the Available Fields list: DueDate*DATE ONLY* and DueDate*TIME ONLY*.

21. When you are finished setting the Date Field Formatting options, click OK. The Custom Placeholder dialog displays.

22. In the Placement Options box, select the placement settings for the placeholder.

    

    1. Set the alignment positioning for the placeholder.

       • Vertical Alignment: Determines placement along the vertical axis. Options include Top, Center, or Bottom. Top is the default.

       • Horizontal Alignment: Determines placement along the horizontal axis. Options include Left, Center, or Right. Left is the default.

    2. Set the left and right indentation for the placeholder. This setting determines the horizontal spacing to the left or right of the page margins.
    3. Set the truncation for the placeholder. Truncation determines the number of characters at which the field value will be truncated. The default value is 128 characters.

23. If you want to save your Custom Placeholder formatting to a file, to be used later, click the Save button, enter a Description for the placeholder, and click OK. You will also be prompted to save the custom placeholder definition before you exit the Custom Placeholder Definition dialog.

24. When you are finished creating the custom placeholder, click OK. The Save Changes dialog box displays.
    1. Click Yes to save the custom placeholder definition.
    2. Enter a Description for the placeholder.
    3. Click OK.
25. The Success dialog appears indicating the ID number for the saved Placeholder. The Custom Placeholder Configuration dialog closes.
26. The Flex Processor Rules Manager dialog displays. Click Save Rule to save your changes.
27. Click Exit.

 

Related Topics

Create Custom Placeholders for a Streaming Imaging Job